-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
JsonConverter`1.xml
345 lines (322 loc) · 21.5 KB
/
JsonConverter`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<Type Name="JsonConverter<T>" FullName="System.Text.Json.Serialization.JsonConverter<T>">
<TypeSignature Language="C#" Value="public abstract class JsonConverter<T> : System.Text.Json.Serialization.JsonConverter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit JsonConverter`1<T> extends System.Text.Json.Serialization.JsonConverter" />
<TypeSignature Language="DocId" Value="T:System.Text.Json.Serialization.JsonConverter`1" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class JsonConverter(Of T)
Inherits JsonConverter" />
<TypeSignature Language="F#" Value="type JsonConverter<'T> = class
 inherit JsonConverter" />
<TypeSignature Language="C++ CLI" Value="generic <typename T>
public ref class JsonConverter abstract : System::Text::Json::Serialization::JsonConverter" />
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Text.Json.Serialization.JsonConverter</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="T">The type of object or value handled by the converter.</typeparam>
<summary>Converts an object or value to or from JSON.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal JsonConverter ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Serialization.JsonConverter`1.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Friend Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected public:
 JsonConverter();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new <see cref="T:System.Text.Json.Serialization.JsonConverter`1" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanConvert">
<MemberSignature Language="C#" Value="public override bool CanConvert (Type typeToConvert);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanConvert(class System.Type typeToConvert) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Serialization.JsonConverter`1.CanConvert(System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanConvert (typeToConvert As Type) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanConvert : Type -> bool" Usage="jsonConverter.CanConvert typeToConvert" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanConvert(Type ^ typeToConvert);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="typeToConvert" Type="System.Type" />
</Parameters>
<Docs>
<param name="typeToConvert">The type to compare against.</param>
<summary>Determines whether the specified type can be converted.</summary>
<returns>
<see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HandleNull">
<MemberSignature Language="C#" Value="public virtual bool HandleNull { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HandleNull" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Serialization.JsonConverter`1.HandleNull" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property HandleNull As Boolean" />
<MemberSignature Language="F#" Value="member this.HandleNull : bool" Usage="System.Text.Json.Serialization.JsonConverter<'T>.HandleNull" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool HandleNull { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether <see langword="null" /> should be passed to the converter on serialization, and whether <see cref="F:System.Text.Json.JsonTokenType.Null" /> should be passed on deserialization.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value is `true` for converters for value types, and `false` for converters for reference types.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public abstract T? Read (ref System.Text.Json.Utf8JsonReader reader, Type typeToConvert, System.Text.Json.JsonSerializerOptions options);" FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !T Read(valuetype System.Text.Json.Utf8JsonReader& reader, class System.Type typeToConvert, class System.Text.Json.JsonSerializerOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Serialization.JsonConverter`1.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Read (ByRef reader As Utf8JsonReader, typeToConvert As Type, options As JsonSerializerOptions) As T" />
<MemberSignature Language="F#" Value="abstract member Read : Utf8JsonReader * Type * System.Text.Json.JsonSerializerOptions -> 'T" Usage="jsonConverter.Read (reader, typeToConvert, options)" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract T Read(System::Text::Json::Utf8JsonReader % reader, Type ^ typeToConvert, System::Text::Json::JsonSerializerOptions ^ options);" />
<MemberSignature Language="C#" Value="public abstract T Read (ref System.Text.Json.Utf8JsonReader reader, Type typeToConvert, System.Text.Json.JsonSerializerOptions options);" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Text.Json.Utf8JsonReader" RefType="ref" />
<Parameter Name="typeToConvert" Type="System.Type" />
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="reader">The reader.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">An object that specifies serialization options to use.</param>
<summary>Reads and converts the JSON to type <typeparamref name="T" />.</summary>
<returns>The converted value.</returns>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ReadAsPropertyName">
<MemberSignature Language="C#" Value="public virtual T ReadAsPropertyName (ref System.Text.Json.Utf8JsonReader reader, Type typeToConvert, System.Text.Json.JsonSerializerOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !T ReadAsPropertyName(valuetype System.Text.Json.Utf8JsonReader& reader, class System.Type typeToConvert, class System.Text.Json.JsonSerializerOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Serialization.JsonConverter`1.ReadAsPropertyName(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReadAsPropertyName (ByRef reader As Utf8JsonReader, typeToConvert As Type, options As JsonSerializerOptions) As T" />
<MemberSignature Language="F#" Value="abstract member ReadAsPropertyName : Utf8JsonReader * Type * System.Text.Json.JsonSerializerOptions -> 'T
override this.ReadAsPropertyName : Utf8JsonReader * Type * System.Text.Json.JsonSerializerOptions -> 'T" Usage="jsonConverter.ReadAsPropertyName (reader, typeToConvert, options)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual T ReadAsPropertyName(System::Text::Json::Utf8JsonReader % reader, Type ^ typeToConvert, System::Text::Json::JsonSerializerOptions ^ options);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Text.Json.Utf8JsonReader" RefType="ref" Index="0" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<Parameter Name="typeToConvert" Type="System.Type" Index="1" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" Index="2" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
</Parameters>
<Docs>
<param name="reader">The <see cref="T:System.Text.Json.Utf8JsonReader" /> to read from.</param>
<param name="typeToConvert">The type to convert.</param>
<param name="options">The options to use when reading the value.</param>
<summary>Reads a dictionary key from a JSON property name.</summary>
<returns>The value that was converted.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method should be overridden in custom converters of types used in deserialized dictionary keys.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public override sealed Type Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type Type" />
<MemberSignature Language="DocId" Value="P:System.Text.Json.Serialization.JsonConverter`1.Type" />
<MemberSignature Language="VB.NET" Value="Public Overrides NotOverridable ReadOnly Property Type As Type" />
<MemberSignature Language="F#" Value="member this.Type : Type" Usage="System.Text.Json.Serialization.JsonConverter<'T>.Type" />
<MemberSignature Language="C++ CLI" Value="public:
 property Type ^ Type { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public abstract void Write (System.Text.Json.Utf8JsonWriter writer, T value, System.Text.Json.JsonSerializerOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Write(class System.Text.Json.Utf8JsonWriter writer, !T value, class System.Text.Json.JsonSerializerOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Serialization.JsonConverter`1.Write(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Sub Write (writer As Utf8JsonWriter, value As T, options As JsonSerializerOptions)" />
<MemberSignature Language="F#" Value="abstract member Write : System.Text.Json.Utf8JsonWriter * 'T * System.Text.Json.JsonSerializerOptions -> unit" Usage="jsonConverter.Write (writer, value, options)" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract void Write(System::Text::Json::Utf8JsonWriter ^ writer, T value, System::Text::Json::JsonSerializerOptions ^ options);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" />
<Parameter Name="value" Type="T">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" />
</Parameters>
<Docs>
<param name="writer">The writer to write to.</param>
<param name="value">The value to convert to JSON.</param>
<param name="options">An object that specifies serialization options to use.</param>
<summary>Writes a specified value as JSON.</summary>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteAsPropertyName">
<MemberSignature Language="C#" Value="public virtual void WriteAsPropertyName (System.Text.Json.Utf8JsonWriter writer, T value, System.Text.Json.JsonSerializerOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void WriteAsPropertyName(class System.Text.Json.Utf8JsonWriter writer, !T value, class System.Text.Json.JsonSerializerOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Text.Json.Serialization.JsonConverter`1.WriteAsPropertyName(System.Text.Json.Utf8JsonWriter,`0,System.Text.Json.JsonSerializerOptions)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub WriteAsPropertyName (writer As Utf8JsonWriter, value As T, options As JsonSerializerOptions)" />
<MemberSignature Language="F#" Value="abstract member WriteAsPropertyName : System.Text.Json.Utf8JsonWriter * 'T * System.Text.Json.JsonSerializerOptions -> unit
override this.WriteAsPropertyName : System.Text.Json.Utf8JsonWriter * 'T * System.Text.Json.JsonSerializerOptions -> unit" Usage="jsonConverter.WriteAsPropertyName (writer, value, options)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void WriteAsPropertyName(System::Text::Json::Utf8JsonWriter ^ writer, T value, System::Text::Json::JsonSerializerOptions ^ options);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Text.Json</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Text.Json.Utf8JsonWriter" Index="0" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<Parameter Name="value" Type="T" Index="1" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0">
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.DisallowNull]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.DisallowNull>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="options" Type="System.Text.Json.JsonSerializerOptions" Index="2" FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
</Parameters>
<Docs>
<param name="writer">The <see cref="T:System.Text.Json.Utf8JsonWriter" /> to write to.</param>
<param name="value">The value to convert. The value of <see cref="P:System.Text.Json.Serialization.JsonConverter`1.HandleNull" /> determines if the converter handles <see langword="null" /> values.</param>
<param name="options">The options to use when writing the value.</param>
<summary>Writes a dictionary key as a JSON property name.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method should be overridden in custom converters of types used in serialized dictionary keys.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>